// --------------------------------------------------------------------------------------------------------------------
// <copyright file="ISimpleModbusTCPConnection.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------

namespace Microsoft.Robotics.Hardware.Modbus
{
    using System;

    /// <summary>
    /// Interface for a simple ModbusTCP connection
    /// <see href="http://www.simplymodbus.ca/"></see>
    /// </summary>
    public interface ISimpleModbusTCPConnection : IDisposable
    {
        /// <summary>
        /// Set multiple registers.
        /// </summary>
        /// <param name="unitID">Slave device ID.</param>
        /// <param name="addressOfFirstRegister">Address of register to begin writing at.</param>
        /// <param name="wordsToWriteCount">Number of words to write.</param>
        /// <param name="registers">Values to write.  Each register is one word in length.</param>
        void PresetMultipleRegisters(byte unitID, ushort addressOfFirstRegister, ushort wordsToWriteCount, ushort[] registers);

        /// <summary>
        /// Creates a ReadInputRegisters request, sends it to the slave device, 
        /// reads the response, and places them into the out parameter. 
        /// </summary>
        /// <param name="unitID">ID of the slave device.</param>
        /// <param name="addressOfFirstRegister">Address of the first register to read.</param>
        /// <param name="wordsToReadCount">Number of 16-bit words to read.</param>
        /// <param name="registers">Returns the registers read in response.</param>
        void ReadInputRegisters(byte unitID, ushort addressOfFirstRegister, ushort wordsToReadCount, out ushort[] registers);
    }
}
